Vcenter Lcm Deployment MigrationUpgrade Status Info

Vcenter Lcm Deployment MigrationUpgrade Status Info
Vcenter Lcm Deployment MigrationUpgrade Status Info

The Vcenter Lcm Deployment MigrationUpgrade Status Info schema contains properties to describe the state of the appliance.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "subtasks": {
        "subtasks": {
            "progress": {
                "total": 0,
                "completed": 0,
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            },
            "notifications": {
                "info": [
                    {
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        }
                    }
                ],
                "warnings": [
                    {
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        }
                    }
                ],
                "errors": [
                    {
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        }
                    }
                ]
            },
            "description": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            },
            "status": "string",
            "cancelable": false,
            "error": {},
            "start_time": "string",
            "end_time": "string"
        }
    },
    "subtask_order": [
        "string"
    ],
    "current_state": "string",
    "desired_state": "string",
    "progress": {
        "total": 0,
        "completed": 0,
        "message": {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    },
    "notifications": {
        "info": [
            {
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            }
        ],
        "warnings": [
            {
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            }
        ],
        "errors": [
            {
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            }
        ]
    },
    "upgrade_info": {
        "upgrade_to": "string",
        "start_switchover": "string",
        "pause": "string",
        "error": {},
        "remaining_replication_data": 0,
        "identifier": "string"
    },
    "last_update_time": "string",
    "description": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "status": "string",
    "cancelable": false,
    "error": {},
    "start_time": "string",
    "end_time": "string"
}
object
subtasks
Required

The map of the upgrade subtasks and their status information.

This property was added in vSphere API 9.0.0.0.

array of string
subtask_order
Required

The ordered list of subtasks for this upgrade operation.

This property was added in vSphere API 9.0.0.0.

string
current_state
Optional

The current state of migration upgrade process.

For more information see: Vcenter Lcm Deployment MigrationUpgrade Status State.

This property was added in vSphere API 9.0.0.0.

If missing or null there is no upgrade running in the environment.

string
desired_state
Optional

Desired state of the migration upgrade process.

For more information see: Vcenter Lcm Deployment MigrationUpgrade Status State.

This property was added in vSphere API 9.0.0.0.

If missing or null there is no configured upgrade in the environment.

progress
Optional

The progress information of the current upgrade process.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of CommonInfo#status is one of Vcenter Lcm Deployment Common Status.RUNNING, Vcenter Lcm Deployment Common Status.BLOCKED, Vcenter Lcm Deployment Common Status.SUCCEEDED, Vcenter Lcm Deployment Common Status.FAILED, or Vcenter Lcm Deployment Common Status.CANCELED.

notifications
Optional

Notifications containing upgrade infos, errors and warnings.

This property was added in vSphere API 9.0.0.0.

Only set if an infos, errors or warnings have been reported by the upgrade process.

upgrade_info
Required

The metadata of the upgrade process

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
last_update_time
Required

The time when the status has been updated

This property was added in vSphere API 9.0.0.0.

description
Required

Description of the operation associated with the task.

This property was added in vSphere API 9.0.0.0.

string
status
Required

Status of the operation associated with the task.

For more information see: Vcenter Lcm Deployment Common Status.

This property was added in vSphere API 9.0.0.0.

boolean
cancelable
Required

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.

This property was added in vSphere API 9.0.0.0.

object
error
Optional

Description of the error if the operation status is "FAILED" or the upgrade has been canceled.

This property was added in vSphere API 9.0.0.0.

If missing or null there is no error raised by the upgrade

string As date-time As date-time
start_time
Optional

Time when the operation is started.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is one of Vcenter Lcm Deployment Common Status.RUNNING, Vcenter Lcm Deployment Common Status.BLOCKED, Vcenter Lcm Deployment Common Status.SUCCEEDED, Vcenter Lcm Deployment Common Status.FAILED, or Vcenter Lcm Deployment Common Status.CANCELED.

string As date-time As date-time
end_time
Optional

Time when the operation is completed.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is one of Vcenter Lcm Deployment Common Status.SUCCEEDED, Vcenter Lcm Deployment Common Status.FAILED, or Vcenter Lcm Deployment Common Status.CANCELED.